home *** CD-ROM | disk | FTP | other *** search
/ Alde ADA 5 #1 / ADA CD-ROM - Alde Publishing.iso / simulate / qsaphelp.fil < prev    next >
Encoding:
Text File  |  1988-05-03  |  25.6 KB  |  896 lines

  1. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  2. --batch.hlp
  3. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  4. %BATCH
  5.  
  6. To run the program in batch mode, Choose one of the following
  7. examples pertaining to the system you are running on.
  8.  
  9. DATA GENERAL:
  10.  
  11.    -) csh                           -- get into the Unix C-Shell
  12.    %  qbatch -i -s /notify          -- submit a batch job where INPUT
  13.       x qsap < INPUT > OUTPUT       -- is the input file name and
  14.       ^d                            -- OUTPUT is the output file name
  15.    %  exit                          -- where the results are to go.
  16. %END
  17. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  18. --cbranch.hlp
  19. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  20. %CBRANCH
  21.  
  22. SYNTAX
  23.  
  24.    Cbranch  [=]  {probability_value}
  25.  
  26. DESCRIPTION
  27.  
  28.    Cbranch is used to specify the continuation probabilities between
  29.    stages for a node with an R-Stage Coxian service distribution. The
  30.    number of probability values must be one less than the number of
  31.    stages and each value must be in the range 0.0 .. 1.0 excluding 0.0.
  32.  
  33. EXAMPLES
  34.  
  35.    node    = abc                node    def
  36.    dist    = coxian             dist    coxian
  37.    nstages = 4                  nstages 2
  38.    cbranch = .5, 0.3 .2         c       .75   -- minimum abbreviation
  39.  
  40. PREREQUISITES
  41.  
  42.    Nnodes, order, njobs, node, distribution = coxian, nstages.
  43. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  44. --discipl.hlp
  45. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  46. %DISCIPLINE
  47.  
  48. SYNTAX
  49.  
  50.    DISCipline  [=]  (Fcfs | Nq | PR_lcfs | P_share)
  51.  
  52. DESCRIPTION
  53.  
  54.    Discipline is used to specify the service discipline at a node. If
  55.    a fcfs discipline is chosen then the distribution is automatically
  56.    set to exponential. If a nq discipline is chosen, the number of
  57.    servers is set equal to the number of jobs. If a p_share or pr_lcfs
  58.    discipline is chosen, the number of servers is set to 1.
  59.  
  60. EXAMPLES
  61.  
  62.    node       = a
  63.    discipline = fcfs   -- sets distribution to exponential
  64.    disc         p_     -- resets discip and sets nservers = 1
  65.  
  66. PREREQUISITES
  67.  
  68.    Nnodes, order, njobs, node.
  69. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  70. --distrib.hlp
  71. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  72. %DISTRIBUTION
  73.  
  74. SYNTAX
  75.  
  76.    DISTribution  [=]  (EXponential | ERlang | Coxian)
  77.  
  78. DESCRIPTION
  79.  
  80.    Distribution is used to specify the service distribution at a node.
  81.    For a fcfs discipline, the distribution is set to exponential.
  82.  
  83. EXAMPLES
  84.  
  85.    node         = foo              node   fooy
  86.    distribution = exponential      discip fcfs   -- sets dist to expon
  87.                                    dist   erlang -- causes a warning
  88.  
  89. PREREQUISITES
  90.  
  91.    Nnodes, order, njobs, node.
  92. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  93. --echo.hlp
  94. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  95. %ECHO
  96.  
  97. SYNTAX
  98.  
  99.    ECho  (Yes | No)
  100.  
  101. DESCRIPTION
  102.  
  103.    Echo determines whether or not output reports will be displayed at
  104.    the terminal. This decision is independent of the current outfile
  105.    setting. The default setting is 'Echo Yes'.
  106.  
  107. EXAMPLES
  108.  
  109.    echo  no
  110.  
  111.    ec y    -- minimum abbreviation
  112.  
  113. PREREQUISITES
  114.  
  115.    None
  116. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  117. --endnode.hlp
  118. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  119. %ENDNODE
  120.  
  121. SYNTAX
  122.  
  123.    ENdnode
  124.  
  125. DESCRIPTION
  126.  
  127.    Endnode is used to signal the end of a node definition block.
  128.    Commands occurring after a 'node' command which pertain to the node
  129.    will not be saved into the model until the endnode command is issued.
  130.    If this command is issued when the node information is not complete,
  131.    a message will be printed indicating which commands are missing.
  132.  
  133. EXAMPLES
  134.  
  135.    node  peter_pan                  node  fairy
  136.         .                                .
  137.    endnode                          en        -- minimum abbreviation
  138.  
  139. PREREQUISITES
  140.  
  141.    Nnodes, order, njobs, node, and all node subcommands.
  142. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  143. --example.hlp
  144. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  145. %EXAMPLE
  146.  
  147. This contains an example model definition.
  148.  
  149.  
  150. nnodes  3              -- sets the number of nodes
  151. order   a,b   c        -- nodes a,b,c in order. Comma and space are
  152. njobs  10              -- valid delimiters.
  153.  
  154. node         a         -- start of node definition block
  155.   discipline fcfs      -- distribution will be set to exponential
  156.   nservers   2
  157.   rate       2.4       -- exponential rate
  158. endnode                -- end of node definition block
  159.  
  160. node         b
  161.   discipline p_share   -- nservers will be set to 1
  162.   dist       erlang    -- a unique abbreviation of distribution is ok
  163.   nstages    3
  164.   rate       3.45      -- this rate applies to each of the 3 stages
  165. end
  166.  
  167. node         c
  168.   discip     nq        -- nservers will be set to 10 = njobs
  169.   dist       coxian
  170.   nstages    4
  171.   cbranch    .4 .2 .3  -- nstages-1 continuation probabilities
  172.   rates     1.4  4.5
  173.             2.3  5.7   -- command can extend over more than one line
  174. end
  175.  
  176. run                    -- executes the model
  177.  
  178. report  arrival_freq    all
  179. report  serv_times      (a c)
  180. report  response_time   a
  181. report  qlength_dist    (b c)
  182. report  throughput      all
  183. report  routing         from a  to all  by c
  184. report  serv_requir     all a c
  185. report  normalization
  186. report  pbranch
  187. report  model
  188. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  189. --excepts.hlp
  190. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  191.  
  192. %EXCEPTS
  193.  
  194. DESCRIPTION    -- EXCEPTIONS
  195.  
  196.  
  197.       During execution any uncorrectable exception is reported 
  198.  and control is returned to the MMI module. The user may then wish
  199.  to quit or attempt to correct the situation. Several types of
  200.  exceptions are listed below:
  201.  
  202. MATRIX_INVERSION_ERROR: 
  203.  
  204.          The matrix of branching probabilities can not be inverted.
  205.  
  206.          Corrective Action: Change branching probs. 
  207.          
  208. UNSTABLE_SOLUTION_ERROR:
  209.  
  210.          Occurs whenever the result of a calculation yields an
  211.          unrealistic value. The equations described in the appendix B
  212.          may yield values that exceed the accuracy or capacity of the
  213.          target system. Depending on the equation, QSAP may attempt
  214.          an alternate solution, may report the error and continue 
  215.          processing, or give up and raise the Unstable_Solution_Error
  216.          exception.
  217.  
  218.          Corrective Action: Try changing input values such as service
  219.                             rates and number ofjobs. Severe bottlenecks
  220.                             are likely candidates for this type of
  221.                             error.  
  222.          
  223. UNKNOWN_EXCEPTION:
  224.  
  225.          Any other exception will be reported as an unknown exception.
  226.  
  227.          Corrective Action: Hopefully, the user will be able to retrace
  228.                  his steps and find the error. If the installation is 
  229.                  maintaining a bug helpfile, try the help facility. 
  230. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  231. --fixql.hlp
  232. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  233.  
  234.  
  235. %FIX_QL
  236.  
  237. DESCRIPTION    -- A FIX for QLENGTHS
  238.  
  239.       While computing equation 1.2.0.11, an erronous value for 'l' has been 
  240.       detected. To continue , this value has been set to zero. Hence,
  241.       the computed value for qlength for this node may be suspect. 
  242.       
  243. CAUSE
  244.  
  245.       This situation can occur when there is a serious bottleneck at one
  246.       of the nodes. The equation 1.2.0.11, in appendix B, will then
  247.       attempt to subtract two extremely close numbers whose difference
  248.       is beyond the accuracy of the machine. The ramifications of this
  249.       problem may seriously distort the qlength distribution for that node. 
  250.  
  251. CORRECTIVE ACTION
  252.  
  253.       The value for 'l' has been reassigned to zero which results in
  254.       qlength probability of zero. It appears that 'l' misbehaves
  255.       only in the negligible reqions of the qlength distribution
  256.       and hence assigning qlength probability to zero should
  257.       not seriously impact any of the reports. 
  258.  
  259.  VERIFY Q_LENGTHS
  260.       One can easily check if the correction has worked by examining
  261.       the Thru_Put report. If the sum of the mean queue lengths 
  262.       approximates the number of jobs, then the 'fix' worked.
  263.       If not, then reduce the BOTTLENECK!
  264. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  265. --help.hlp
  266. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  267. %HELP
  268.  
  269. SYNTAX
  270.  
  271.    Help [help_topic]
  272.  
  273. DESCRIPTION
  274.  
  275.    Help provides online information on commands and other features. If
  276.    the help_topic keyword is not supplied, then a list of all help
  277.    topics is displayed.
  278.  
  279. EXAMPLES
  280.  
  281.    help         -- gives a list of all help topics
  282.    help nnodes  -- describes the nnodes command
  283.    h nn         -- minimum abbreviation
  284.  
  285. PREREQUISITES
  286.  
  287.    none
  288. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  289. --index.hlp
  290. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  291. This help file must be modified by the following rules.
  292.  
  293. * All text before '%INDEX' is treated as comments.
  294. * The first occurance of '%' on any line in column 1 must be the start
  295.   of the index.
  296. * The index consists of '%INDEX' starting in column 1 and the
  297.   help topics following one per line and also starting in column 1.
  298.   The index is terminated by a '%END' in column 1 of a subsequent line.
  299. * A help topic must be listed in the index.
  300. * A help topic will be located in a file with the same name. In this
  301.   file a help topic named 'TOPIC' will start with '%TOPIC' in column 1
  302.   and end with either '%' encountered in column 1 on a subsequent
  303.   line or end of file.
  304. * Topic names are limited in length. For the index to print properly,
  305.   a name should not be more than 19 characters. However, if the
  306.   system cannot accomodate 19 characters in a file name, then they
  307.   will have to be shorter.
  308. * Topic text is displayed all at once, so the topics should be small
  309.   enough to fit on one page.
  310.  
  311. %INDEX
  312. Batch
  313. Cbranch
  314. DISCipl
  315. DISTrib
  316. ECho
  317. ENdnode
  318. EXAmple
  319. EXCepts
  320. Fix_ql
  321. Help
  322. Infile
  323. NEw_User
  324. NOde
  325. NNodes
  326. NJobs
  327. NSErvers
  328. NSTages
  329. ORder
  330. OUtfile
  331. PAging
  332. PBranch
  333. PRompt
  334. Quit
  335. RAtes
  336. REPort
  337. RESet
  338. RUn
  339. SAve
  340. Show
  341. Title
  342. %END
  343. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  344. --infile.hlp
  345. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  346. %INFILE
  347.  
  348. SYNTAX
  349.  
  350.    Infile  file_name
  351.  
  352. DESCRIPTION
  353.  
  354.    Infile is used to execute commands from a file. The file can contain
  355.    a complete or partial model definition. The file can contain any
  356.    command except another infile command.
  357.  
  358. EXAMPLES
  359.  
  360.    infile = my_file    -- reads from file, my_file
  361.    i my_model          -- minimum abbreviation
  362.  
  363. PREREQUISITES
  364.  
  365.    None
  366. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  367. --newuser.hlp
  368. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  369. %NEW_USER
  370.  
  371. This contains some important items that the user should be aware of.
  372.  
  373. * The online help facility can be useful. Type 'help' for a list of
  374.   topics and 'help topic' for information on that topic.
  375.  
  376. * The command format is free. A command can span more than one line.
  377.   More than one command can occur on a single line. The characters ',',
  378.   '=', and space are delimiters. ORDER a,b c=d     e is equivalent to
  379.   ORDER a b c d e.
  380.  
  381. * In edit mode the program will not respond to the command until all
  382.   of the necessary command parameters have been supplied. If a command
  383.   seems to hang it is because something is missing. The only commands
  384.   that take more than a few seconds are 'report' and 'run'.
  385.  
  386. * Abbreviated commands are possible. For example 'or a' is equavalent
  387.   to 'order a'. The help information and the prompt mode follow the
  388.   convention that the minimum abbreviation of a word is in upper case
  389.   and the rest of the word is in lower case.
  390.  
  391. * The character '\' is a character kill (some systems cannot handle
  392.   the backspace character). For example, caad\\re\ is equal to care.
  393.  
  394. * Real values can be entered without leading zeros or trailing decimal
  395.   points. For example, .5 and 3 can be entered where a real is expected.
  396. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  397. --njobs.hlp
  398. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  399. %NJOBS
  400.  
  401. SYNTAX
  402.  
  403.    NJobs  [=]  natural_number
  404.  
  405. DESCRIPTION
  406.  
  407.    Njobs is used to specify the number of jobs in the network layout.
  408.    It can be issued and re-issued at any time.
  409.  
  410. EXAMPLES
  411.  
  412.    njobs = 13
  413.  
  414.    nj 14  -- minimum abbreviation
  415.  
  416. PREREQUISITES
  417.  
  418.    None
  419. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  420. --nnodes.hlp
  421. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  422. %NNODES
  423.  
  424. SYNTAX
  425.  
  426.    NNodes  [=]  natural_number
  427.  
  428. DESCRIPTION
  429.  
  430.    Nnodes is used to specify the number of nodes in the network layout.
  431.    It is generally the first command issued and once issued, it cannot
  432.    be re-issued until after a reset.
  433.  
  434. EXAMPLES
  435.  
  436.    nnodes = 10
  437.  
  438.    nn 2   -- minimum abbreviation
  439.  
  440. PREREQUISITES
  441.  
  442.    Reset or initial entry into the program.
  443. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  444. --node.hlp
  445. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  446. %NODE
  447.  
  448. SYNTAX
  449.  
  450.    NOde  [=]  node_name
  451.  
  452. DESCRIPTION
  453.  
  454.    Node is used to signal the beginning of a node definition block. The
  455.    node_name must match a node that was specified in the order command.
  456.    Commands subsequent to the node command which pertain to the node
  457.    will not be saved into the model until the endnode command is issued.
  458.  
  459. EXAMPLES
  460.  
  461.    node  capacitor                no  resistor  -- minimum abbreviation
  462.         .                                .
  463.         .                                .
  464.    endnode                        endnode
  465.  
  466. PREREQUISITES
  467.  
  468.    Nnodes, order, njobs.
  469. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  470. --nservers.hlp
  471. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  472. %NSERVERS
  473.  
  474. SYNTAX
  475.  
  476.    NSErvers  [=]  natural_number
  477.  
  478. DESCRIPTION
  479.  
  480.    Nservers is used to specify the number of servers at a node. If a
  481.    NQ discipline is chosen then nservers is set equal to the number of
  482.    jobs. If a PS or PR_LCFS discipline is chosen then nservers is set
  483.    equal to 1. A FCFS discipline is the only one which does not force
  484.    a specific value for nservers.
  485.  
  486. EXAMPLES
  487.  
  488.    node     = puff              node   sleepy
  489.    discip   = fcfs              discip ps  -- nservers will be set to 1
  490.    nservers = 10                nse    5   -- will cause a warning
  491.  
  492. PREREQUISITES
  493.  
  494.    Nnodes, order, njobs, node.
  495. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  496. --nstages.hlp
  497. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  498. %NSTAGES
  499.  
  500. SYNTAX
  501.  
  502.    NSTages  [=]  natural_number
  503.  
  504. DESCRIPTION
  505.  
  506.    Nstages is used to specify the number of stages of an R-Stage Erlang
  507.    or Coxian distribution at a node.
  508.  
  509. EXAMPLES
  510.  
  511.    node    = jiffy                  node zorba
  512.    dist    = erlang                 dist coxian
  513.    nstages = 6                      nst  3       -- minimum abbreviation
  514.  
  515. PREREQUISITES
  516.  
  517.    Nnodes, order, njobs, node, distribution = erlang or coxian.
  518. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  519. --order.hlp
  520. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  521. %ORDER
  522.  
  523. SYNTAX
  524.  
  525.    ORder  [=]  [(] {node_name} [)]
  526.  
  527. DESCRIPTION
  528.  
  529.    Order is used to specify the node names and their order in the
  530.    network layout. A node name can be up to 15 characters in length
  531.    and can contain any characters except ',', '=', '#' or blank. A
  532.    node name cannot be 'all', 'from', 'by', 'to', which are reserved
  533.    words.
  534.  
  535. EXAMPLES
  536.  
  537.    nnodes = 4
  538.    order    (cpu, disk terminal, modem)
  539.  
  540.    or     Bob Ted Carol Alice     -- minimum abbreviation
  541.  
  542. PREREQUISITES
  543.  
  544.    Nnodes
  545. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  546. --outfile.hlp
  547. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  548. %OUTFILE
  549.  
  550. SYNTAX
  551.  
  552.    OUtfile  [=]  (file_name | TERMINAL)
  553.  
  554. DESCRIPTION
  555.  
  556.    Outfile is used to open or close a file for output reports. Reports
  557.    will automatically be displayed at the terminal if the current echo
  558.    setting is yes (the default). If the terminal keyword is specified
  559.    and an outfile file is already open, the file will be closed. This
  560.    command will destroy the contents of a file that exists previously.
  561.  
  562. EXAMPLES
  563.  
  564.    outfile  =  my_file     -- opens the file, my_reports
  565.    outfile     terminal    -- closes the file
  566.    ou reports              -- minimum abbreviation
  567.  
  568. PREREQUISITES
  569.  
  570.    None
  571. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  572. --paging.hlp
  573. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  574. %PAGING
  575.  
  576. SYNTAX
  577.  
  578.    PAging  (Yes | No)
  579.  
  580. DESCRIPTION
  581.  
  582.    Paging allows the terminal to be treated like a line printer by
  583.    putting in new page marks. This is useful if run in batch, since
  584.    the session input and output reports may be going to the same file.
  585.    Reports generally start with a new page mark. 'Paging No' is the
  586.    default.
  587.  
  588. EXAMPLES
  589.  
  590.    paging  yes
  591.  
  592.    pa n    -- minimum abbreviation
  593.  
  594. PREREQUISITES
  595.  
  596.    None
  597. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  598. --pbranch.hlp
  599. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  600. %PBRANCH
  601.  
  602. SYNTAX
  603.  
  604.    PBranch  [=]  {probability_value}
  605.  
  606. DESCRIPTION
  607.  
  608.    Pbranch is used to specify the branching probabilities between nodes
  609.    in a network layout. Each node has associated with it a set of
  610.    probabilities that a job terminating at the node will continue on
  611.    to another node. There are exactly as many probabilities associated
  612.    with each node as there are nodes. The probabilites for each node
  613.    must sum to 1.
  614.  
  615. EXAMPLES
  616.  
  617.    node    = a                     node b
  618.    pbranch = .3, .2 0.5            pb   .6 .3 .1   -- minimum abbrev
  619.  
  620. PREREQUISITES
  621.  
  622.    Nnodes, order, njobs, node.
  623. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  624. --prompt.hlp
  625. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  626. %PROMPT
  627.  
  628. SYNTAX
  629.  
  630.    PRompt
  631.  
  632. DESCRIPTION
  633.  
  634.    Prompt is used to enter a mode where specific questions are asked
  635.    by the program in order to build a complete model. There is no
  636.    way to exit this mode short of entering a complete model definition.
  637.    This command will cause a model reset upon user confirmation. The
  638.    prompt sign is 'P>' as opposed to 'E>' in the normal editing mode.
  639.  
  640. EXAMPLES
  641.  
  642.    E> prompt
  643.       Enter the number of nodes.
  644.    P> 3
  645.       etc.
  646.  
  647. PREREQUISITES
  648.  
  649.    None
  650. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  651. --quit.hlp
  652. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  653. %QUIT
  654.  
  655. SYNTAX
  656.  
  657.    Quit
  658.  
  659. DESCRIPTION
  660.  
  661.    Quit is used to end a session. The user must verify this action as
  662.    a precaution against not entering the save command.
  663.  
  664. EXAMPLE
  665.  
  666.    E> quit     -- could use 'q' as well.
  667.  
  668.    This will cause the current model definition to be lost.
  669.    Continue (Yes, No)?
  670.    P> no       -- could use 'n' as well
  671.  
  672. PREREQUISITES
  673.  
  674.    None
  675. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  676. --rates.hlp
  677. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  678. %RATES
  679.  
  680. SYNTAX
  681.  
  682.    RAtes  [=]  {real_value}
  683.  
  684. DESCRIPTION
  685.  
  686.    Rates is used to specify the rate parameter for an exponential or
  687.    erlang distribution and the rate parameter(s) for a coxian
  688.    distribution.
  689.  
  690. EXAMPLES
  691.  
  692.    node    = a_register              node b_register
  693.    dist    = coxian                  dist exponential
  694.    nstages = 3                       ra   5.4  -- minimum abbreviation
  695.    rates   = 1.5, 2.5 3.5
  696.  
  697. PREREQUISITES
  698.  
  699.    Nnodes, order, njobs, node, distribution. If coxian, nstages.
  700. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  701. --report.hlp
  702. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  703. %REPORT
  704.  
  705. SYNTAX
  706.  
  707.    REPort  (Arrival_Frequencies   | SERV_Times | REsponse_times |
  708.             Qlength_distributions | Throughput)  node_list
  709.  
  710.    REPort  (ROuting | SERV_Requirements)  [FROM]  node_list
  711.             [TO] node_list  [BY] node_list
  712.  
  713.    REPort  (Model | Normalizations | Pbranch)
  714.  
  715.    node_list  ::=  (node_name  |  ({node_name})  |  ALL
  716.  
  717. DESCRIPTION
  718.  
  719.    Report generates output reports based on the latest model definition
  720.    that was run. A summary of the reports follows.
  721.  
  722.    Arrival_frequencies:
  723.       For each node in node_list, reports number of servers, discipline,
  724.       and relative arrival frequency.
  725.    Model:
  726.       Reports the model definition consisting of edit commands.
  727.    Normalizations:
  728.       Reports normalizations constants for all values from 0 to the
  729.       number of jobs in the model.
  730.    Pbranch:
  731.       Reports branching probabilities from all nodes to all nodes.
  732.    Qlength_distributions:
  733.       For each node in node_list and each njobs value from 0 to
  734.       the number of jobs, reports the probability that the node has
  735.       that many jobs.
  736.    Response_times:
  737.       Reports the response time mean, response time variance, and
  738.       coefficient of variation for each node in node_list.
  739.    Routing:
  740.       Reports service tour mean and variance for each combination of
  741.       nodes, taking one from each of the 'from', 'to' and 'by' node
  742.       lists.
  743.    Serv_requirements:
  744.       Reports the service requirement mean, service requirement
  745.       variance, and the residence time mean for each combination of
  746.       nodes, taking one from each of the 'from', 'to' and 'by' node
  747.       lists.
  748.    Serv_times:
  749.       For each node in node_list, reports distribution, mean service
  750.       time, service time variance, coefficient of variation, service
  751.       rate(s), number of stages, cbranch probabilities.
  752.    Throughput:
  753.       For each node in node_list, reports mean queue length, queue
  754.       length variance, coefficient of variation, throughput, and
  755.       utilization.
  756.  
  757. EXAMPLES
  758.  
  759.    report  arrival_frequencies (a b c)
  760.    rep     t all                            -- abbreviations
  761.    report  routing from (a b) to all by c
  762.    rep     serv_r  a (a b) all              -- abbreviations
  763.    report  model
  764.    rep     p                                -- abbreviations
  765.  
  766. PREREQUISITES
  767.  
  768.    Run
  769. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  770. --reset.hlp
  771. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  772. %RESET
  773.  
  774. SYNTAX
  775.  
  776.    REset
  777.  
  778. DESCRIPTION
  779.  
  780.    Reset has the effect of undoing all model definition commands (those
  781.    except for echo, outfile, paging). The user must verify this action
  782.    as a precaution against not entering the save command.
  783.  
  784. EXAMPLES
  785.  
  786.    E> reset    -- could use 're' as well
  787.  
  788.    This will cause the current model definition to be lost.
  789.    Continue (Yes, No)?
  790.    P> yes      -- could use 'y' as well
  791.  
  792. PREREQUISITES
  793.  
  794.    None
  795. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  796. --run.hlp
  797. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  798. %RUN
  799.  
  800. SYNTAX
  801.  
  802.    RUn
  803.  
  804. DESCRIPTION
  805.  
  806.    Run is used to execute the closed model calculations on the current
  807.    model definition. All input parameters are checked before the
  808.    calculations are performed.
  809.  
  810. EXAMPLE
  811.  
  812.    run
  813.  
  814. PREREQUISITES
  815.  
  816.    The model must be complete.
  817. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  818. --save.hlp
  819. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  820. %SAVE
  821.  
  822. SYNTAX
  823.  
  824.    SAve  [=]  file_name
  825.  
  826. DESCRIPTION
  827.  
  828.    Save is used to save the current model definition onto a file,
  829.    whether it be complete or not. This command will destroy the
  830.    contents of file_name if it already exists. The commands that are
  831.    saved include title, nnodes, order, njobs, node, pbranch,
  832.    discipline, distribution, rates, nstages, cbranch, and endnode.
  833.  
  834. EXAMPLES
  835.  
  836.    save  my_file
  837.  
  838.    sa    your_file      -- minimum abbreviation
  839.  
  840. PREREQUISITES
  841.  
  842.    None
  843. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  844. --show.hlp
  845. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  846. %SHOW
  847.  
  848. SYNTAX
  849.  
  850.    SHow  (Title | NNodes | Order | NJobs | NOde node_name | Model)
  851.  
  852. DESCRIPTION
  853.  
  854.    This command is used to display the current model definition
  855.    parameters. 'Show model' will display all of them.
  856.  
  857. EXAMPLES
  858.  
  859.    E> show title
  860.      title = Assembly Line
  861.  
  862.    E> sh m   -- minimum abbreviation, will show entire model
  863.      nnodes = 3
  864.            .
  865.            .
  866.  
  867. PREREQUISITES
  868.  
  869.    None
  870. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  871. --title.hlp
  872. --::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  873. %TITLE
  874.  
  875. SYNTAX
  876.  
  877.    Title  [=]  title_specification
  878.  
  879. DESCRIPTION
  880.  
  881.    Title is used to a specify a title for the model that will appear
  882.    on all output reports. The title specification must appear on the
  883.    same line as the command and cannot exceed 50 characters in
  884.    length.
  885.  
  886. EXAMPLES
  887.  
  888.    title  My Main Model
  889.  
  890.    t   A vERy OdD tITle     -- minimum abbreviation
  891.  
  892. PREREQUISITES
  893.  
  894.    None
  895.  
  896.